<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>overviews</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            >MetaGETA (Metadata Gathering, Extraction and Transformation)</th>
          </tr></table></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        Module&nbsp;overviews
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
        <tr><td align="right"><span class="options"
            >[<a href="frames.html" target="_top">frames</a
            >]&nbsp;|&nbsp;<a href="overviews-module.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<!-- ==================== MODULE DESCRIPTION ==================== -->
<h1 class="epydoc">Module overviews</h1><p class="nomargin-top"><span class="codelink"><a href="overviews-pysrc.html">source&nbsp;code</a></span></p>
<p>Generate overviews for imagery</p>

<hr />
<div class="fields">      <p><strong>Note:</strong>
        This module is not generally used on its own, but may be if 
        required. It's is usually used only by <a 
        href="formats.__dataset__.Dataset-class.html#getoverview" 
        class="link">Dataset.getoverview()</a> methods.
      </p>
</div><!-- ==================== FUNCTIONS ==================== -->
<a name="section-Functions"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Functions</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-Functions"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type"><code>str</code></span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="overviews-module.html#getoverview" class="summary-sig-name">getoverview</a>(<span class="summary-sig-arg">ds</span>,
        <span class="summary-sig-arg">outfile</span>,
        <span class="summary-sig-arg">width</span>,
        <span class="summary-sig-arg">format</span>,
        <span class="summary-sig-arg">bands</span>,
        <span class="summary-sig-arg">stretch_type</span>,
        <span class="summary-sig-arg">*stretch_args</span>)</span><br />
      Generate overviews for imagery</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="overviews-pysrc.html#getoverview">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type"><code>xml</code></span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="overviews-module.html#stretch" class="summary-sig-name">stretch</a>(<span class="summary-sig-arg">stretchType</span>,
        <span class="summary-sig-arg">vrtcols</span>,
        <span class="summary-sig-arg">vrtrows</span>,
        <span class="summary-sig-arg">*args</span>)</span><br />
      Calls the requested stretch function.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="overviews-pysrc.html#stretch">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr class="private">
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type"><code>xml</code></span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="overviews-module.html#_stretch_NONE" class="summary-sig-name" onclick="show_private();">_stretch_NONE</a>(<span class="summary-sig-arg">vrtcols</span>,
        <span class="summary-sig-arg">vrtrows</span>,
        <span class="summary-sig-arg">ds</span>,
        <span class="summary-sig-arg">bands</span>)</span><br />
      No stretch.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="overviews-pysrc.html#_stretch_NONE">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr class="private">
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type"><code>xml</code></span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="overviews-module.html#_stretch_PERCENT" class="summary-sig-name" onclick="show_private();">_stretch_PERCENT</a>(<span class="summary-sig-arg">vrtcols</span>,
        <span class="summary-sig-arg">vrtrows</span>,
        <span class="summary-sig-arg">ds</span>,
        <span class="summary-sig-arg">bands</span>,
        <span class="summary-sig-arg">low</span>,
        <span class="summary-sig-arg">high</span>)</span><br />
      Min, max percentage stretch.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="overviews-pysrc.html#_stretch_PERCENT">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr class="private">
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type"><code>xml</code></span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="overviews-module.html#_stretch_MINMAX" class="summary-sig-name" onclick="show_private();">_stretch_MINMAX</a>(<span class="summary-sig-arg">vrtcols</span>,
        <span class="summary-sig-arg">vrtrows</span>,
        <span class="summary-sig-arg">ds</span>,
        <span class="summary-sig-arg">bands</span>)</span><br />
      Minimum-maximum stretch.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="overviews-pysrc.html#_stretch_MINMAX">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr class="private">
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type"><code>xml</code></span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="overviews-module.html#_stretch_STDDEV" class="summary-sig-name" onclick="show_private();">_stretch_STDDEV</a>(<span class="summary-sig-arg">vrtcols</span>,
        <span class="summary-sig-arg">vrtrows</span>,
        <span class="summary-sig-arg">ds</span>,
        <span class="summary-sig-arg">bands</span>,
        <span class="summary-sig-arg">std</span>)</span><br />
      Standard deviation stretch.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="overviews-pysrc.html#_stretch_STDDEV">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr class="private">
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type"><code>xml</code></span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="overviews-module.html#_stretch_UNIQUE" class="summary-sig-name" onclick="show_private();">_stretch_UNIQUE</a>(<span class="summary-sig-arg">vrtcols</span>,
        <span class="summary-sig-arg">vrtrows</span>,
        <span class="summary-sig-arg">ds</span>,
        <span class="summary-sig-arg">bands</span>,
        <span class="summary-sig-arg">vals</span>)</span><br />
      Unique values stretch.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="overviews-pysrc.html#_stretch_UNIQUE">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr class="private">
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type"><code>xml</code></span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="overviews-module.html#_stretch_RANDOM" class="summary-sig-name" onclick="show_private();">_stretch_RANDOM</a>(<span class="summary-sig-arg">vrtcols</span>,
        <span class="summary-sig-arg">vrtrows</span>,
        <span class="summary-sig-arg">ds</span>,
        <span class="summary-sig-arg">bands</span>)</span><br />
      Random values stretch.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="overviews-pysrc.html#_stretch_RANDOM">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr class="private">
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type"><code>xml</code></span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="overviews-module.html#_stretch_COLOURTABLE" class="summary-sig-name" onclick="show_private();">_stretch_COLOURTABLE</a>(<span class="summary-sig-arg">vrtcols</span>,
        <span class="summary-sig-arg">vrtrows</span>,
        <span class="summary-sig-arg">ds</span>,
        <span class="summary-sig-arg">bands</span>)</span><br />
      Colour table stretch.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="overviews-pysrc.html#_stretch_COLOURTABLE">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr class="private">
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type"><code>xml</code></span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="overviews-module.html#_stretch_COLORTABLE" class="summary-sig-name" onclick="show_private();">_stretch_COLORTABLE</a>(<span class="summary-sig-arg">vrtcols</span>,
        <span class="summary-sig-arg">vrtrows</span>,
        <span class="summary-sig-arg">ds</span>,
        <span class="summary-sig-arg">bands</span>)</span><br />
      Colour table stretch.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="overviews-pysrc.html#_stretch_COLOURTABLE">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr class="private">
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type"><code>xml</code></span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="overviews-module.html#_stretch_COLOURTABLELUT" class="summary-sig-name" onclick="show_private();">_stretch_COLOURTABLELUT</a>(<span class="summary-sig-arg">vrtcols</span>,
        <span class="summary-sig-arg">vrtrows</span>,
        <span class="summary-sig-arg">ds</span>,
        <span class="summary-sig-arg">bands</span>,
        <span class="summary-sig-arg">clr</span>)</span><br />
      Colour table file LUT stretch.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="overviews-pysrc.html#_stretch_COLOURTABLELUT">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr class="private">
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type"><code>xml</code></span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="overviews-module.html#_stretch_COLORTABLELUT" class="summary-sig-name" onclick="show_private();">_stretch_COLORTABLELUT</a>(<span class="summary-sig-arg">vrtcols</span>,
        <span class="summary-sig-arg">vrtrows</span>,
        <span class="summary-sig-arg">ds</span>,
        <span class="summary-sig-arg">bands</span>,
        <span class="summary-sig-arg">clr</span>)</span><br />
      Colour table file LUT stretch.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="overviews-pysrc.html#_stretch_COLOURTABLELUT">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="GetStatistics"></a><span class="summary-sig-name">GetStatistics</span>(<span class="summary-sig-arg">band</span>,
        <span class="summary-sig-arg">*args</span>,
        <span class="summary-sig-arg">**kwargs</span>)</span></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="overviews-pysrc.html#GetStatistics">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type"><code>[float,float]</code></span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="overviews-module.html#GetScaleRatioOffset" class="summary-sig-name">GetScaleRatioOffset</a>(<span class="summary-sig-arg">dfScaleSrcMin</span>,
        <span class="summary-sig-arg">dfScaleSrcMax</span>,
        <span class="summary-sig-arg">dfScaleDstMin</span>,
        <span class="summary-sig-arg">dfScaleDstMax</span>)</span><br />
      Calculate data scale and offset</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="overviews-pysrc.html#GetScaleRatioOffset">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type"><code>[int,int]</code></span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="overviews-module.html#GetDataTypeRange" class="summary-sig-name">GetDataTypeRange</a>(<span class="summary-sig-arg">datatype</span>)</span><br />
      Calculate data type range</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="overviews-pysrc.html#GetDataTypeRange">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type"><code>float</code></span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="overviews-module.html#HistPercentileValue" class="summary-sig-name">HistPercentileValue</a>(<span class="summary-sig-arg">inhist</span>,
        <span class="summary-sig-arg">percent</span>,
        <span class="summary-sig-arg">binsize</span>,
        <span class="summary-sig-arg">lowerlimit</span>)</span><br />
      Returns the score at a given percentile relative to the distribution 
      given by inhist.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="overviews-pysrc.html#HistPercentileValue">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type"><code>list</code></span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="overviews-module.html#ParseColourLUT" class="summary-sig-name">ParseColourLUT</a>(<span class="summary-sig-arg">filepath</span>)</span><br />
      Open and parse a colour lookup table</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="overviews-pysrc.html#ParseColourLUT">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type"><code>list</code></span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="overviews-module.html#ParseColorLUT" class="summary-sig-name">ParseColorLUT</a>(<span class="summary-sig-arg">filepath</span>)</span><br />
      Open and parse a colour lookup table</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="overviews-pysrc.html#ParseColourLUT">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type"><code>list</code></span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="overviews-module.html#ExpandedColourLUT" class="summary-sig-name">ExpandedColourLUT</a>(<span class="summary-sig-arg">filepath</span>,
        <span class="summary-sig-arg">nvals</span>)</span><br />
      Open and parse a colour lookup table, expanding missing values as 
      required.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="overviews-pysrc.html#ExpandedColourLUT">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type"><code>list</code></span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="overviews-module.html#ExpandedColorLUT" class="summary-sig-name">ExpandedColorLUT</a>(<span class="summary-sig-arg">filepath</span>,
        <span class="summary-sig-arg">nvals</span>)</span><br />
      Open and parse a colour lookup table, expanding missing values as 
      required.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="overviews-pysrc.html#ExpandedColourLUT">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type"><code>str</code></span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="overviews-module.html#resize" class="summary-sig-name">resize</a>(<span class="summary-sig-arg">infile</span>,
        <span class="summary-sig-arg">outfile</span>,
        <span class="summary-sig-arg">width</span>)</span><br />
      Resize an image</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="overviews-pysrc.html#resize">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
</table>
<!-- ==================== VARIABLES ==================== -->
<a name="section-Variables"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Variables</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-Variables"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a name="__package__"></a><span class="summary-name">__package__</span> = <code title="None">None</code>
    </td>
  </tr>
</table>
<!-- ==================== FUNCTION DETAILS ==================== -->
<a name="section-FunctionDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Function Details</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-FunctionDetails"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
</table>
<a name="getoverview"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">getoverview</span>(<span class="sig-arg">ds</span>,
        <span class="sig-arg">outfile</span>,
        <span class="sig-arg">width</span>,
        <span class="sig-arg">format</span>,
        <span class="sig-arg">bands</span>,
        <span class="sig-arg">stretch_type</span>,
        <span class="sig-arg">*stretch_args</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="overviews-pysrc.html#getoverview">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Generate overviews for imagery</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>ds</code></strong> (<code>GDALDataset</code>) - a GDALDataset object</li>
        <li><strong class="pname"><code>outfile</code></strong> (<code>str</code>) - a filepath to the output overview image. If supplied, format is 
          determined from the file extension</li>
        <li><strong class="pname"><code>width</code></strong> (<code>int</code>) - output image width</li>
        <li><strong class="pname"><code>format</code></strong> (<code>str</code>) - format to generate overview image, one of 
          ['JPG','PNG','GIF','BMP','TIF']. Not required if outfile is 
          supplied.</li>
        <li><strong class="pname"><code>bands</code></strong> (<code>list</code>) - list of band numbers (base 1) in processing order - e.g [3,2,1]</li>
        <li><strong class="pname"><code>stretch_type</code></strong> (<code>str</code>) - stretch to apply to overview image, one of [<a 
          href="overviews-module.html#_stretch_NONE" class="link" 
          onclick="show_private();">NONE</a>,<a 
          href="overviews-module.html#_stretch_PERCENT" class="link" 
          onclick="show_private();">PERCENT</a>,<a 
          href="overviews-module.html#_stretch_MINMAX" class="link" 
          onclick="show_private();">MINMAX</a>,<a 
          href="overviews-module.html#_stretch_STDDEV" class="link" 
          onclick="show_private();">STDDEV</a>,<a 
          href="overviews-module.html#_stretch_COLOURTABLE" class="link" 
          onclick="show_private();">COLOURTABLE</a>,<a 
          href="overviews-module.html#_stretch_COLOURTABLELUT" class="link"
          onclick="show_private();">COLOURTABLELUT</a>,<a 
          href="overviews-module.html#_stretch_RANDOM" class="link" 
          onclick="show_private();">RANDOM</a>,<a 
          href="overviews-module.html#_stretch_UNIQUE" class="link" 
          onclick="show_private();">UNIQUE</a>].</li>
        <li><strong class="pname"><code>stretch_args</code></strong> (<code>list</code>) - args to pass to the stretch algorithms</li>
    </ul></dd>
    <dt>Returns: <code>str</code></dt>
        <dd>filepath (if outfile is supplied)/binary image data (if outfile 
          is not supplied)</dd>
  </dl>
</td></tr></table>
</div>
<a name="stretch"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">stretch</span>(<span class="sig-arg">stretchType</span>,
        <span class="sig-arg">vrtcols</span>,
        <span class="sig-arg">vrtrows</span>,
        <span class="sig-arg">*args</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="overviews-pysrc.html#stretch">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Calls the requested stretch function.</p>
  <p>For further info on VRT's, see the <a 
  href="http://www.gdal.org/gdal_vrttut.html" target="_top">GDAL VRT 
  Tutorial</a></p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>stretchType</code></strong> (<code>str</code>) - One of COLORTABLE, COLORTABLELUT, COLOURTABLE, COLOURTABLELUT, 
          MINMAX, NONE, PERCENT, RANDOM, STDDEV, UNIQUE</li>
        <li><strong class="pname"><code>vrtcols</code></strong> (<code>int</code>) - The number of columns in the output VRT</li>
        <li><strong class="pname"><code>vrtrows</code></strong> (<code>int</code>) - The number of rows in the output VRT</li>
        <li><strong class="pname"><code>args</code></strong> - Other args</li>
    </ul></dd>
    <dt>Returns: <code>xml</code></dt>
        <dd>VRT XML string</dd>
  </dl>
</td></tr></table>
</div>
<a name="_stretch_NONE"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">_stretch_NONE</span>(<span class="sig-arg">vrtcols</span>,
        <span class="sig-arg">vrtrows</span>,
        <span class="sig-arg">ds</span>,
        <span class="sig-arg">bands</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="overviews-pysrc.html#_stretch_NONE">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>No stretch.</p>
  <p>For further info on VRT's, see the <a 
  href="http://www.gdal.org/gdal_vrttut.html" target="_top">GDAL VRT 
  Tutorial</a></p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>ds</code></strong> (<code>gdal.Dataset</code>) - A gdal dataset object</li>
        <li><strong class="pname"><code>bands</code></strong> (<code>[int,...,int]</code>) - A list of band numbers to output (in output order). E.g [4,2,1] 
          Band numbers are not zero indexed.</li>
    </ul></dd>
    <dt>Returns: <code>xml</code></dt>
        <dd>VRT XML string</dd>
  </dl>
</td></tr></table>
</div>
<a name="_stretch_PERCENT"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">_stretch_PERCENT</span>(<span class="sig-arg">vrtcols</span>,
        <span class="sig-arg">vrtrows</span>,
        <span class="sig-arg">ds</span>,
        <span class="sig-arg">bands</span>,
        <span class="sig-arg">low</span>,
        <span class="sig-arg">high</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="overviews-pysrc.html#_stretch_PERCENT">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Min, max percentage stretch.</p>
  <p>For further info on VRT's, see the <a 
  href="http://www.gdal.org/gdal_vrttut.html" target="_top">GDAL VRT 
  Tutorial</a></p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>ds</code></strong> (<code>gdal.Dataset</code>) - A gdal dataset object</li>
        <li><strong class="pname"><code>bands</code></strong> (<code>[int,...,int]</code>) - A list of band numbers to output (in output order). E.g [4,2,1] 
          Band numbers are not zero indexed.</li>
        <li><strong class="pname"><code>low</code></strong> (<code>float</code>) - Minimum percentage</li>
        <li><strong class="pname"><code>high</code></strong> (<code>float</code>) - Maximum percentage</li>
    </ul></dd>
    <dt>Returns: <code>xml</code></dt>
        <dd>VRT XML string</dd>
  </dl>
</td></tr></table>
</div>
<a name="_stretch_MINMAX"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">_stretch_MINMAX</span>(<span class="sig-arg">vrtcols</span>,
        <span class="sig-arg">vrtrows</span>,
        <span class="sig-arg">ds</span>,
        <span class="sig-arg">bands</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="overviews-pysrc.html#_stretch_MINMAX">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Minimum-maximum stretch.</p>
  <p>For further info on VRT's, see the <a 
  href="http://www.gdal.org/gdal_vrttut.html" target="_top">GDAL VRT 
  Tutorial</a></p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>ds</code></strong> (<code>gdal.Dataset</code>) - A gdal dataset object</li>
        <li><strong class="pname"><code>bands</code></strong> (<code>[int,...,int]</code>) - A list of band numbers to output (in output order). E.g [4,2,1] 
          Band numbers are not zero indexed.</li>
    </ul></dd>
    <dt>Returns: <code>xml</code></dt>
        <dd>VRT XML string</dd>
  </dl>
</td></tr></table>
</div>
<a name="_stretch_STDDEV"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">_stretch_STDDEV</span>(<span class="sig-arg">vrtcols</span>,
        <span class="sig-arg">vrtrows</span>,
        <span class="sig-arg">ds</span>,
        <span class="sig-arg">bands</span>,
        <span class="sig-arg">std</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="overviews-pysrc.html#_stretch_STDDEV">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Standard deviation stretch.</p>
  <p>For further info on VRT's, see the <a 
  href="http://www.gdal.org/gdal_vrttut.html" target="_top">GDAL VRT 
  Tutorial</a></p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>ds</code></strong> (<code>gdal.Dataset</code>) - A gdal dataset object</li>
        <li><strong class="pname"><code>bands</code></strong> (<code>[int,...,int]</code>) - A list of band numbers to output (in output order). E.g [4,2,1] 
          Band numbers are not zero indexed.</li>
        <li><strong class="pname"><code>std</code></strong> (float) - Standard deviation</li>
    </ul></dd>
    <dt>Returns: <code>xml</code></dt>
        <dd>VRT XML string</dd>
  </dl>
</td></tr></table>
</div>
<a name="_stretch_UNIQUE"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">_stretch_UNIQUE</span>(<span class="sig-arg">vrtcols</span>,
        <span class="sig-arg">vrtrows</span>,
        <span class="sig-arg">ds</span>,
        <span class="sig-arg">bands</span>,
        <span class="sig-arg">vals</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="overviews-pysrc.html#_stretch_UNIQUE">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Unique values stretch.</p>
  <p>For further info on VRT's, see the <a 
  href="http://www.gdal.org/gdal_vrttut.html" target="_top">GDAL VRT 
  Tutorial</a></p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>ds</code></strong> (<code>gdal.Dataset</code>) - A gdal dataset object</li>
        <li><strong class="pname"><code>bands</code></strong> (<code>[int]</code>) - Band number to output. Band numbers are not zero indexed.</li>
        <li><strong class="pname"><code>vals</code></strong> (<code>list/tuple</code>) - List of cell values and R,G,B[,A] values e.g [(12, 0,0,0), (25, 
          255,255,255)]</li>
    </ul></dd>
    <dt>Returns: <code>xml</code></dt>
        <dd>VRT XML string</dd>
  </dl>
</td></tr></table>
</div>
<a name="_stretch_RANDOM"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">_stretch_RANDOM</span>(<span class="sig-arg">vrtcols</span>,
        <span class="sig-arg">vrtrows</span>,
        <span class="sig-arg">ds</span>,
        <span class="sig-arg">bands</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="overviews-pysrc.html#_stretch_RANDOM">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Random values stretch.</p>
  <p>For further info on VRT's, see the <a 
  href="http://www.gdal.org/gdal_vrttut.html" target="_top">GDAL VRT 
  Tutorial</a></p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>ds</code></strong> (<code>gdal.Dataset</code>) - A gdal dataset object</li>
        <li><strong class="pname"><code>bands</code></strong> (<code>[int]</code>) - Band number to output. Band numbers are not zero indexed.</li>
    </ul></dd>
    <dt>Returns: <code>xml</code></dt>
        <dd>VRT XML string</dd>
  </dl>
<div class="fields">      <p><strong>Change Log:</strong>
        22/01/2010 lpinner fix for <a 
    href="http://code.google.com/p/metageta/issues/detail?id=2&amp;can=1" 
    target="_top">r2</a>
      </p>
</div></td></tr></table>
</div>
<a name="_stretch_COLOURTABLE"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">_stretch_COLOURTABLE</span>(<span class="sig-arg">vrtcols</span>,
        <span class="sig-arg">vrtrows</span>,
        <span class="sig-arg">ds</span>,
        <span class="sig-arg">bands</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="overviews-pysrc.html#_stretch_COLOURTABLE">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Colour table stretch.</p>
  <p>This is a workaround for GDAL not liking color tables with negative or
  missing values. <a href="http://trac.osgeo.org/gdal/ticket/3253" 
  target="_top">r3253</a></p>
  <p>For further info on VRT's, see the <a 
  href="http://www.gdal.org/gdal_vrttut.html" target="_top">GDAL VRT 
  Tutorial</a></p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>ds</code></strong> (<code>gdal.Dataset</code>) - A gdal dataset object</li>
        <li><strong class="pname"><code>bands</code></strong> (<code>[int]</code>) - Band number to output. Band numbers are not zero indexed.</li>
    </ul></dd>
    <dt>Returns: <code>xml</code></dt>
        <dd>VRT XML string</dd>
  </dl>
</td></tr></table>
</div>
<a name="_stretch_COLORTABLE"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">_stretch_COLORTABLE</span>(<span class="sig-arg">vrtcols</span>,
        <span class="sig-arg">vrtrows</span>,
        <span class="sig-arg">ds</span>,
        <span class="sig-arg">bands</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="overviews-pysrc.html#_stretch_COLOURTABLE">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Colour table stretch.</p>
  <p>This is a workaround for GDAL not liking color tables with negative or
  missing values. <a href="http://trac.osgeo.org/gdal/ticket/3253" 
  target="_top">r3253</a></p>
  <p>For further info on VRT's, see the <a 
  href="http://www.gdal.org/gdal_vrttut.html" target="_top">GDAL VRT 
  Tutorial</a></p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>ds</code></strong> (<code>gdal.Dataset</code>) - A gdal dataset object</li>
        <li><strong class="pname"><code>bands</code></strong> (<code>[int]</code>) - Band number to output. Band numbers are not zero indexed.</li>
    </ul></dd>
    <dt>Returns: <code>xml</code></dt>
        <dd>VRT XML string</dd>
  </dl>
</td></tr></table>
</div>
<a name="_stretch_COLOURTABLELUT"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">_stretch_COLOURTABLELUT</span>(<span class="sig-arg">vrtcols</span>,
        <span class="sig-arg">vrtrows</span>,
        <span class="sig-arg">ds</span>,
        <span class="sig-arg">bands</span>,
        <span class="sig-arg">clr</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="overviews-pysrc.html#_stretch_COLOURTABLELUT">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Colour table file LUT stretch.</p>
  <p>This is a workaround for GDAL not liking color tables with negative or
  missing values. <a href="http://trac.osgeo.org/gdal/ticket/3253" 
  target="_top">r3253</a></p>
  <p>For further info on VRT's, see the <a 
  href="http://www.gdal.org/gdal_vrttut.html" target="_top">GDAL VRT 
  Tutorial</a></p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>ds</code></strong> (<code>gdal.Dataset</code>) - A gdal dataset object</li>
        <li><strong class="pname"><code>bands</code></strong> (<code>[int]</code>) - Band number to output. Band numbers are not zero indexed.</li>
        <li><strong class="pname"><code>clr</code></strong> (<code>str</code>) - Path to colour lookup file. See file format in <a 
          href="overviews-module.html#ParseColourLUT" 
          class="link">ParseColourLUT</a></li>
    </ul></dd>
    <dt>Returns: <code>xml</code></dt>
        <dd>VRT XML string</dd>
  </dl>
</td></tr></table>
</div>
<a name="_stretch_COLORTABLELUT"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">_stretch_COLORTABLELUT</span>(<span class="sig-arg">vrtcols</span>,
        <span class="sig-arg">vrtrows</span>,
        <span class="sig-arg">ds</span>,
        <span class="sig-arg">bands</span>,
        <span class="sig-arg">clr</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="overviews-pysrc.html#_stretch_COLOURTABLELUT">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Colour table file LUT stretch.</p>
  <p>This is a workaround for GDAL not liking color tables with negative or
  missing values. <a href="http://trac.osgeo.org/gdal/ticket/3253" 
  target="_top">r3253</a></p>
  <p>For further info on VRT's, see the <a 
  href="http://www.gdal.org/gdal_vrttut.html" target="_top">GDAL VRT 
  Tutorial</a></p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>ds</code></strong> (<code>gdal.Dataset</code>) - A gdal dataset object</li>
        <li><strong class="pname"><code>bands</code></strong> (<code>[int]</code>) - Band number to output. Band numbers are not zero indexed.</li>
        <li><strong class="pname"><code>clr</code></strong> (<code>str</code>) - Path to colour lookup file. See file format in <a 
          href="overviews-module.html#ParseColourLUT" 
          class="link">ParseColourLUT</a></li>
    </ul></dd>
    <dt>Returns: <code>xml</code></dt>
        <dd>VRT XML string</dd>
  </dl>
</td></tr></table>
</div>
<a name="GetScaleRatioOffset"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">GetScaleRatioOffset</span>(<span class="sig-arg">dfScaleSrcMin</span>,
        <span class="sig-arg">dfScaleSrcMax</span>,
        <span class="sig-arg">dfScaleDstMin</span>,
        <span class="sig-arg">dfScaleDstMax</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="overviews-pysrc.html#GetScaleRatioOffset">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Calculate data scale and offset</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>dfScaleSrcMin</code></strong> (<code>float</code>) - input minimum value</li>
        <li><strong class="pname"><code>dfScaleSrcMax</code></strong> (<code>float</code>) - input maximum value</li>
        <li><strong class="pname"><code>dfScaleDstMin</code></strong> (<code>float</code>) - output minimum value</li>
        <li><strong class="pname"><code>dfScaleDstMax</code></strong> (<code>float</code>) - output maximum value</li>
    </ul></dd>
    <dt>Returns: <code>[float,float]</code></dt>
        <dd>Scale and offset values</dd>
  </dl>
</td></tr></table>
</div>
<a name="GetDataTypeRange"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">GetDataTypeRange</span>(<span class="sig-arg">datatype</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="overviews-pysrc.html#GetDataTypeRange">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Calculate data type range</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>datatype</code></strong> (<code>int</code>) - gdal data type constant</li>
    </ul></dd>
    <dt>Returns: <code>[int,int]</code></dt>
        <dd>Min and max value for data type</dd>
  </dl>
</td></tr></table>
</div>
<a name="HistPercentileValue"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">HistPercentileValue</span>(<span class="sig-arg">inhist</span>,
        <span class="sig-arg">percent</span>,
        <span class="sig-arg">binsize</span>,
        <span class="sig-arg">lowerlimit</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="overviews-pysrc.html#HistPercentileValue">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Returns the score at a given percentile relative to the distribution 
  given by inhist.</p>
  <p>Usage:   histpercentilevalue(inhist, percent, binsize,lowerlimit)</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>inhist</code></strong> (<code>list</code>) - gdal histogram</li>
        <li><strong class="pname"><code>percent</code></strong> (<code>float</code>) - percentile to return score for</li>
        <li><strong class="pname"><code>binsize</code></strong> (<code>float</code>) - width of histogram bins</li>
        <li><strong class="pname"><code>lowerlimit</code></strong> (<code>float</code>) - min value of histogram</li>
    </ul></dd>
    <dt>Returns: <code>float</code></dt>
        <dd>score at a given percentile</dd>
  </dl>
</td></tr></table>
</div>
<a name="ParseColourLUT"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">ParseColourLUT</span>(<span class="sig-arg">filepath</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="overviews-pysrc.html#ParseColourLUT">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Open and parse a colour lookup table</p>
  <p>Values must be space separated. Comment characters are stripped out. 
  Format is: <code>pixel red green blue [optional alpha]</code>. Pixel 
  value may be a range (eg 15-20). The following comment characters may be 
  used: <code>'#' '//' ';' '/*'</code>.</p>
  <p>Example:</p>
<pre class="literalblock">
       #value   R   G   B   A
        11-15   255 0   0   255 #(red)
        16      255 165 0   255 #(orange)
        18      255 255 0   255 #(yellow)
        19      0   255 0   255 /*(green)
        21      0   0   255 255 /*(blue)
        98      0   255 255 255 ;(cyan)
        99-255  160 32  240 255 ;(purple)
</pre>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>filepath</code></strong> (<code>str</code>) - Path to colour lookup file</li>
    </ul></dd>
    <dt>Returns: <code>list</code></dt>
        <dd>List of cell values and R,G,B,A values e.g ((12,0,0,0,255), 
          (25,255,255,255,0))</dd>
  </dl>
</td></tr></table>
</div>
<a name="ParseColorLUT"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">ParseColorLUT</span>(<span class="sig-arg">filepath</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="overviews-pysrc.html#ParseColourLUT">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Open and parse a colour lookup table</p>
  <p>Values must be space separated. Comment characters are stripped out. 
  Format is: <code>pixel red green blue [optional alpha]</code>. Pixel 
  value may be a range (eg 15-20). The following comment characters may be 
  used: <code>'#' '//' ';' '/*'</code>.</p>
  <p>Example:</p>
<pre class="literalblock">
       #value   R   G   B   A
        11-15   255 0   0   255 #(red)
        16      255 165 0   255 #(orange)
        18      255 255 0   255 #(yellow)
        19      0   255 0   255 /*(green)
        21      0   0   255 255 /*(blue)
        98      0   255 255 255 ;(cyan)
        99-255  160 32  240 255 ;(purple)
</pre>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>filepath</code></strong> (<code>str</code>) - Path to colour lookup file</li>
    </ul></dd>
    <dt>Returns: <code>list</code></dt>
        <dd>List of cell values and R,G,B,A values e.g ((12,0,0,0,255), 
          (25,255,255,255,0))</dd>
  </dl>
</td></tr></table>
</div>
<a name="ExpandedColourLUT"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">ExpandedColourLUT</span>(<span class="sig-arg">filepath</span>,
        <span class="sig-arg">nvals</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="overviews-pysrc.html#ExpandedColourLUT">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Open and parse a colour lookup table, expanding missing values as 
  required.</p>
  <p>Values must be space separated. Comment characters are stripped out. 
  Format is: <code>pixel red green blue [optional alpha]</code>. Pixel 
  value may be a range (eg 15-20). The following comment characters may be 
  used: <code>'#' '//' ';' '/*'</code>.</p>
  <p>Example:</p>
<pre class="literalblock">
       #value   R   G   B   A
        11-15   255 0   0   255 #(red)
        16      255 165 0   255 #(orange)
        18      255 255 0   255 #(yellow)
        19      0   255 0   255 /*(green)
        21      0   0   255 255 /*(blue)
        98      0   255 255 255 ;(cyan)
        99-255  160 32  240 255 ;(purple)
</pre>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>filepath</code></strong> (<code>str</code>) - Path to colour lookup file</li>
        <li><strong class="pname"><code>nvals</code></strong> (<code>int</code>) - Number of values</li>
    </ul></dd>
    <dt>Returns: <code>list</code></dt>
        <dd>List of cell and R,G,B,A values e.g ((12,0,0,0,255), 
          (25,255,255,255,0))</dd>
  </dl>
</td></tr></table>
</div>
<a name="ExpandedColorLUT"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">ExpandedColorLUT</span>(<span class="sig-arg">filepath</span>,
        <span class="sig-arg">nvals</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="overviews-pysrc.html#ExpandedColourLUT">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Open and parse a colour lookup table, expanding missing values as 
  required.</p>
  <p>Values must be space separated. Comment characters are stripped out. 
  Format is: <code>pixel red green blue [optional alpha]</code>. Pixel 
  value may be a range (eg 15-20). The following comment characters may be 
  used: <code>'#' '//' ';' '/*'</code>.</p>
  <p>Example:</p>
<pre class="literalblock">
       #value   R   G   B   A
        11-15   255 0   0   255 #(red)
        16      255 165 0   255 #(orange)
        18      255 255 0   255 #(yellow)
        19      0   255 0   255 /*(green)
        21      0   0   255 255 /*(blue)
        98      0   255 255 255 ;(cyan)
        99-255  160 32  240 255 ;(purple)
</pre>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>filepath</code></strong> (<code>str</code>) - Path to colour lookup file</li>
        <li><strong class="pname"><code>nvals</code></strong> (<code>int</code>) - Number of values</li>
    </ul></dd>
    <dt>Returns: <code>list</code></dt>
        <dd>List of cell and R,G,B,A values e.g ((12,0,0,0,255), 
          (25,255,255,255,0))</dd>
  </dl>
</td></tr></table>
</div>
<a name="resize"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">resize</span>(<span class="sig-arg">infile</span>,
        <span class="sig-arg">outfile</span>,
        <span class="sig-arg">width</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="overviews-pysrc.html#resize">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Resize an image</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>infile</code></strong> (<code>str</code>) - Path to image to resize</li>
        <li><strong class="pname"><code>outfile</code></strong> (<code>str</code>) - Path to output image that will be created</li>
        <li><strong class="pname"><code>width</code></strong> (<code>int</code>) - Width in pixels of output image</li>
    </ul></dd>
    <dt>Returns: <code>str</code></dt>
        <dd>Path to output image that was created</dd>
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            >MetaGETA (Metadata Gathering, Extraction and Transformation)</th>
          </tr></table></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    &nbsp;
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>
